cs-selling-experience-api-services

This section provides the meaning of the attributes included in the API.

🗂️ Base Information

• API Title: Experience Selling API
• Version: 1.0.0
• Base URL: https:///v1/
• Authentication URL: https://authentication-services-colmena-{{env}}.us-e1.cloudhub.io/tokenReplace {env} with:
  • dev (Development)
  • qa (Quality Assurance)
  • prod (Production)

🔑 API KEYS

• "Authorization": "Bearer {{API_KEY}}"Attribute defined in the request Header.
  • Type: String
  • Length: Minimum 36 characters, maximum 37 characters
  • Description: Authentication token required to access the API.
• "client_id": "{{CLIENT_ID}}"Attribute defined in the request Header.
  • Type: String
  • Length: Minimum 32 characters, maximum 36 characters
  • Description: Unique client identifier to authenticate the request.

NOTE: It is important to have these API KEYS to make any request to our services.

📄 Policy Generation (POST /PolicyIssuance/v1/generatePolicy)

• "policyHolder"
  • Type: Object
  • Description: Information about the policyholder.
  • Attributes:
    • "name": Full name of the policyholder. (String, max 100 characters)
    • "identification": National ID or Passport number. (String, max 20 characters)
    • "address": Residential address. (String, max 150 characters)
• "coverageDetails"
  • Type: Array
  • Description: List of coverages included in the policy.
  • Attributes:
    • "coverageType": Type of insurance coverage. (String, max 50 characters)
    • "sumInsured": Amount insured under this coverage. (Decimal)
• "effectiveDate"
  • Type: Date (ISO 8601 format)
  • Description: The start date of the policy coverage.

List of Relationships

💳 Payment Processing (POST /Services/v1/Payu/paymentPayU)

• "transactionId"
  • Type: String
  • Description: Unique identifier for the payment transaction.
  • Length: 12-36 characters
• "amount"
  • Type: Decimal
  • Description: The payment amount to be processed.
• "paymentMethod"
  • Type: String
  • Description: The method of payment (e.g., Credit Card, PSE).
• "currency"
  • Type: String (ISO 4217)
  • Description: The currency code, such as "COP" or "USD".

✅ Payment Confirmation (POST /Services/v1/Payu/paymentConfirmationPayU)

• "confirmationCode"
  • Type: String
  • Description: Code received from PayU confirming the payment.
• "status"
  • Type: String
  • Description: The status of the payment (e.g., "APPROVED", "DECLINED").
• "paymentDate"
  • Type: DateTime
  • Description: The date and time when the payment was processed.

📑 Policy PDF Generation (POST /Services/v1/ServicePolicyPdf)

• "policyNumber"
  • Type: String
  • Description: The unique number identifying the policy.
• "pdfFormat"
  • Type: String
  • Description: Specifies the PDF format (e.g., A4, Letter).
• "includeSignature"
  • Type: Boolean
  • Description: Determines if the PDF should include an electronic signature.

⚠️ Common Error Codes

📞 Support

For any questions or issues, please contact the API support team at INTEGRATION SERVICES AND APPLICATIONS COORDINATION.

Notes

• Documentation updated in February 2025.
• For additional information, contact: epalma@fgs.co